Skip to content

Commit

Permalink
Added a script to set the TLSN version number of the relevant crates (#…
Browse files Browse the repository at this point in the history
…650)

build: add script to set the TLSN version number
  • Loading branch information
heeckhau authored Dec 12, 2024
1 parent 85e0f5b commit 7bec5a8
Show file tree
Hide file tree
Showing 3 changed files with 213 additions and 89 deletions.
172 changes: 84 additions & 88 deletions crates/notary/server/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,169 +1,165 @@
openapi: 3.0.0

info:
title: Notary Server
description: Notary server written in Rust to provide notarization service.
version: 0.1.0-alpha.7

version: 0.1.0-alpha.8-pre
tags:
- name: General
- name: Notarization

- name: General
- name: Notarization
paths:
/healthcheck:
get:
tags:
- General
- General
description: Healthcheck endpoint
parameters:
- in: header
name: Authorization
description: Whitelisted API key if auth module is turned on
schema:
type: string
required: false
- in: header
name: Authorization
description: Whitelisted API key if auth module is turned on
schema:
type: string
required: false
responses:
"200":
'200':
description: Ok response from server
content:
text/plain:
schema:
type: string
example: "Ok"
"401":
example: Ok
'401':
description: API key is invalid
content:
text/plain:
schema:
type: string
example: "Unauthorized request from prover: Invalid API key."
example: 'Unauthorized request from prover: Invalid API key.'
/info:
get:
tags:
- General
- General
description: General information about the notary server
parameters:
- in: header
name: Authorization
description: Whitelisted API key if auth module is turned on
schema:
type: string
required: false
- in: header
name: Authorization
description: Whitelisted API key if auth module is turned on
schema:
type: string
required: false
responses:
"200":
'200':
description: Info response from server
content:
application/json:
schema:
$ref: "#/components/schemas/InfoResponse"
"401":
$ref: '#/components/schemas/InfoResponse'
'401':
description: API key is invalid
content:
text/plain:
schema:
type: string
example: "Unauthorized request from prover: Invalid API key."
example: 'Unauthorized request from prover: Invalid API key.'
/session:
post:
tags:
- Notarization
- Notarization
description: Initialize and configure notarization for both TCP and WebSocket clients
parameters:
- in: header
name: Content-Type
description: The value must be application/json
schema:
type: string
enum:
- "application/json"
required: true
- in: header
name: Authorization
description: Whitelisted API key if auth module is turned on
schema:
type: string
required: false
- in: header
name: Content-Type
description: The value must be application/json
schema:
type: string
enum:
- application/json
required: true
- in: header
name: Authorization
description: Whitelisted API key if auth module is turned on
schema:
type: string
required: false
requestBody:
description: Notarization session request to server
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NotarizationSessionRequest"
$ref: '#/components/schemas/NotarizationSessionRequest'
responses:
"200":
'200':
description: Notarization session response from server
content:
application/json:
schema:
$ref: "#/components/schemas/NotarizationSessionResponse"
"400":
$ref: '#/components/schemas/NotarizationSessionResponse'
'400':
description: Configuration parameters or headers provided by prover are invalid
content:
text/plain:
schema:
type: string
example: "Invalid request from prover: Failed to deserialize the JSON body into the target type"
"401":
example: 'Invalid request from prover: Failed to deserialize the JSON body into the target type'
'401':
description: API key is invalid
content:
text/plain:
schema:
type: string
example: "Unauthorized request from prover: Invalid API key."
"500":
example: 'Unauthorized request from prover: Invalid API key.'
'500':
description: There was some internal error when processing
content:
text/plain:
schema:
type: string
example: "Something is wrong"
example: Something is wrong
/notarize:
get:
tags:
- Notarization
- Notarization
description: Start notarization for TCP client
parameters:
- in: header
name: Connection
description: The value should be 'Upgrade'
schema:
type: string
enum:
- "Upgrade"
required: true
- in: header
name: Upgrade
description: The value should be 'TCP'
schema:
type: string
enum:
- "TCP"
required: true
- in: query
name: sessionId
description: Unique ID returned from server upon calling POST /session
schema:
type: string
required: true
- in: header
name: Connection
description: The value should be 'Upgrade'
schema:
type: string
enum:
- Upgrade
required: true
- in: header
name: Upgrade
description: The value should be 'TCP'
schema:
type: string
enum:
- TCP
required: true
- in: query
name: sessionId
description: Unique ID returned from server upon calling POST /session
schema:
type: string
required: true
responses:
"101":
'101':
description: Switching protocol response
"400":
'400':
description: Headers provided by prover are invalid
content:
text/plain:
schema:
type: string
example: "Invalid request from prover: Upgrade header is not set for client"
"500":
example: 'Invalid request from prover: Upgrade header is not set for client'
'500':
description: There was some internal error when processing
content:
text/plain:
schema:
type: string
example: "Something is wrong"

example: Something is wrong
components:
schemas:
NotarizationSessionRequest:
Expand All @@ -173,24 +169,24 @@ components:
description: Types of client that the prover is using
type: string
enum:
- "Tcp"
- "Websocket"
- Tcp
- Websocket
maxSentData:
description: Maximum data that can be sent by the prover in bytes
type: integer
maxRecvData:
description: Maximum data that can be received by the prover in bytes
type: integer
required:
- "clientType"
- clientType
NotarizationSessionResponse:
type: object
properties:
sessionId:
description: Unique ID returned from server upon calling POST /session
type: string
required:
- "sessionId"
- sessionId
InfoResponse:
type: object
properties:
Expand All @@ -204,6 +200,6 @@ components:
description: The git commit hash of source code that this notary server is running
type: string
required:
- "version"
- "publicKey"
- "gitCommitHash"
- version
- publicKey
- gitCommitHash
2 changes: 1 addition & 1 deletion crates/wasm/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ ws_stream_wasm = { git = "https://github.com/tlsnotary/ws_stream_wasm", rev = "2

[target.'cfg(target_arch = "wasm32")'.dependencies]
wasm-bindgen-rayon = { version = "1.0" }
getrandom = { version = "0.2", features = ["js"] }
getrandom = { version = "0.2", features = ["js"] }
Loading

0 comments on commit 7bec5a8

Please sign in to comment.