diff --git a/docs/docs/Rest Api/Organization/_source/network.yml b/docs/docs/Rest Api/Organization/_source/network.yml index 8c11c833..f19605b1 100644 --- a/docs/docs/Rest Api/Organization/_source/network.yml +++ b/docs/docs/Rest Api/Organization/_source/network.yml @@ -17,8 +17,9 @@ servers: components: $ref: '../../_schema/security.yml#/components' + security: - - defaultApiKey: [] + - x-ztnet-auth: [] paths: /org/:orgid/network: @@ -28,12 +29,6 @@ paths: Returns an array of Networks you have access to. operationId: getUserNetworks parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: orgid in: path required: true @@ -62,12 +57,6 @@ paths: summary: Create New Network within the Organization operationId: createNewNetwork parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: orgid in: path required: true @@ -110,12 +99,6 @@ paths: summary: Returns information about a specific organization network operationId: getNetworkInfo parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: networkId in: path required: true @@ -147,12 +130,6 @@ paths: summary: Update a specific organization network operationId: updateNetworkInfo parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: networkId in: path required: true diff --git a/docs/docs/Rest Api/Organization/_source/networkMember.yml b/docs/docs/Rest Api/Organization/_source/networkMember.yml index f17c392b..5da860a7 100644 --- a/docs/docs/Rest Api/Organization/_source/networkMember.yml +++ b/docs/docs/Rest Api/Organization/_source/networkMember.yml @@ -17,8 +17,9 @@ servers: components: $ref: '../../_schema/security.yml#/components' + security: - - defaultApiKey: [] + - x-ztnet-auth: [] paths: /org/:orgid/network/{networkId}/member: @@ -26,12 +27,6 @@ paths: summary: Returns a list of Members in a organization network operationId: getNetworkMemberInfo parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: networkId in: path required: true @@ -65,12 +60,6 @@ paths: summary: Returns a specific organization network member operationId: getNetworkMemberByIdInfo parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: networkId in: path required: true @@ -109,11 +98,6 @@ paths: summary: Modify a organization network member description: Modify a organization network member parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - in: path name: networkId required: true diff --git a/docs/docs/Rest Api/Organization/_source/organization.yml b/docs/docs/Rest Api/Organization/_source/organization.yml index 519cbd39..cebc6144 100644 --- a/docs/docs/Rest Api/Organization/_source/organization.yml +++ b/docs/docs/Rest Api/Organization/_source/organization.yml @@ -17,9 +17,10 @@ servers: components: $ref: '../../_schema/security.yml#/components' -security: - - defaultApiKey: [] +security: + - x-ztnet-auth: [] + paths: /org: get: @@ -27,13 +28,6 @@ paths: description: | Returns an array of Organizations you have access to. operationId: getOrganization - parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user responses: 200: description: An array of Network IDs @@ -55,12 +49,6 @@ paths: summary: Returns information of the specified Organization. operationId: getOrganizationInfo parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: orgid in: path required: true diff --git a/docs/docs/Rest Api/Organization/_source/users.yml b/docs/docs/Rest Api/Organization/_source/users.yml index d7ed89db..3689c1df 100644 --- a/docs/docs/Rest Api/Organization/_source/users.yml +++ b/docs/docs/Rest Api/Organization/_source/users.yml @@ -18,8 +18,9 @@ tags: components: $ref: '../../_schema/security.yml#/components' + security: - - defaultApiKey: [] + - x-ztnet-auth: [] paths: /org/:orgid/users: @@ -29,12 +30,6 @@ paths: summary: Returns a list of Users in the organization operationId: getOrganizationUsers parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: orgid in: path required: true diff --git a/docs/docs/Rest Api/Personal/_source/network.yml b/docs/docs/Rest Api/Personal/_source/network.yml index 9ca7308f..b3b2575e 100644 --- a/docs/docs/Rest Api/Personal/_source/network.yml +++ b/docs/docs/Rest Api/Personal/_source/network.yml @@ -17,8 +17,9 @@ servers: components: $ref: '../../_schema/security.yml#/components' + security: - - defaultApiKey: [] + - x-ztnet-auth: [] paths: /network: @@ -27,13 +28,6 @@ paths: description: | Returns an array of Networks you have access to. operationId: getUserNetworks - parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user responses: 200: description: An array of Network IDs @@ -54,13 +48,6 @@ paths: post: summary: Create New Network operationId: createNewNetwork - parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user requestBody: required: false content: @@ -97,12 +84,6 @@ paths: summary: Returns information about a specific network operationId: getNetworkInfo parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: networkId in: path required: true diff --git a/docs/docs/Rest Api/Personal/_source/networkMember.yml b/docs/docs/Rest Api/Personal/_source/networkMember.yml index 02b5d36e..81fd6936 100644 --- a/docs/docs/Rest Api/Personal/_source/networkMember.yml +++ b/docs/docs/Rest Api/Personal/_source/networkMember.yml @@ -17,8 +17,9 @@ servers: components: $ref: '../../_schema/security.yml#/components' + security: - - defaultApiKey: [] + - x-ztnet-auth: [] paths: /network/{networkId}/member: @@ -26,12 +27,6 @@ paths: summary: Returns a list of Members on the network operationId: getNetworkMemberInfo parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user - name: networkId in: path required: true diff --git a/docs/docs/Rest Api/Personal/_source/user.yml b/docs/docs/Rest Api/Personal/_source/user.yml index dbe61af0..a75b3a80 100644 --- a/docs/docs/Rest Api/Personal/_source/user.yml +++ b/docs/docs/Rest Api/Personal/_source/user.yml @@ -18,8 +18,9 @@ tags: components: $ref: '../../_schema/security.yml#/components' + security: - - defaultApiKey: [] + - x-ztnet-auth: [] paths: /user: @@ -28,13 +29,6 @@ paths: - user summary: Create a new user operationId: postNewUser - parameters: - - name: x-ztnet-auth - in: header - required: true - schema: - type: string - description: API Key for the user description: | If no users have been created yet, no API key is required. Otherwise, an API key must be included in the request header. Keep in mind that first user created will be the admin user. @@ -115,12 +109,3 @@ paths: 500: $ref: '../../_http_responses/InternalServerError.yml#/InternalServerError' - components: - operationId: postNewUser - securitySchemes: - x-ztnet-auth: - type: apiKey - required: true - in: header - name: x-ztnet-auth - description: API key can be generated from the ZTNet admin section. diff --git a/docs/docs/Rest Api/_schema/NetworkSchema.yml b/docs/docs/Rest Api/_schema/NetworkSchema.yml index 3cc6566e..a44e56af 100644 --- a/docs/docs/Rest Api/_schema/NetworkSchema.yml +++ b/docs/docs/Rest Api/_schema/NetworkSchema.yml @@ -17,9 +17,14 @@ NetworkResponse: creationTime: type: integer dns: - type: array - items: - type: string + type: object + properties: + domain: + type: string + servers: + type: array + items: + type: string enableBroadcast: type: boolean id: @@ -99,9 +104,15 @@ UpdateNetworkShema: type: object properties: dns: - type: array - items: - type: string + type: object + properties: + domain: + type: string + servers: + type: array + items: + type: string + ipAssignmentPools: type: array items: diff --git a/docs/docs/Rest Api/_schema/security.yml b/docs/docs/Rest Api/_schema/security.yml index 601d2586..2e27545b 100644 --- a/docs/docs/Rest Api/_schema/security.yml +++ b/docs/docs/Rest Api/_schema/security.yml @@ -1,7 +1,7 @@ components: securitySchemes: - defaultApiKey: - description: API key required for access + x-ztnet-auth: type: apiKey + in: header name: x-ztnet-auth - in: header \ No newline at end of file + description: API key required for access \ No newline at end of file