Skip to content

Commit

Permalink
quick fix
Browse files Browse the repository at this point in the history
  • Loading branch information
OlegPhenomenon committed Aug 8, 2024
1 parent de33924 commit cbfd4e3
Showing 1 changed file with 94 additions and 94 deletions.
188 changes: 94 additions & 94 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,102 +23,102 @@ servers:
description: Main API server

paths:
/business_registry/domain_names:
get:
summary: Get available domain name variants
description: |
Generates and returns a list of available domain name variants based on the organization name.
Note: This endpoint does not require a token, but access is restricted to authorized IP addresses only.
parameters:
- in: query
name: organization_name
required: true
schema:
type: string
description: Organization name to generate domain name variants
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
variants:
type: array
items:
type: string
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/business_registry/domain_names:
get:
summary: Get available domain name variants
description: |
Generates and returns a list of available domain name variants based on the organization name.
Note: This endpoint does not require a token, but access is restricted to authorized IP addresses only.
parameters:
- in: query
name: organization_name
required: true
schema:
type: string
description: Organization name to generate domain name variants
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
variants:
type: array
items:
type: string
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'

/business_registry/refresh_token:
patch:
summary: Refresh access token
description: |
Refreshes an existing access token.
The current token must be provided in the X-Auth-Token header.
No request body is required.
Returns a new unique token to replace the current one.
Note: The initial token is issued when a domain is reserved.
security:
- CustomTokenAuth: []
responses:
'200':
description: Token successfully refreshed
content:
application/json:
schema:
type: object
properties:
message:å
type: string
example: "Token refreshed successfully"
token:
type: string
example: "new_unique_token_123xyz"
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/business_registry/refresh_token:
patch:
summary: Refresh access token
description: |
Refreshes an existing access token.
The current token must be provided in the X-Auth-Token header.
No request body is required.
Returns a new unique token to replace the current one.
Note: The initial token is issued when a domain is reserved.
security:
- CustomTokenAuth: []
responses:
'200':
description: Token successfully refreshed
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Token refreshed successfully"
token:
type: string
example: "new_unique_token_123xyz"
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'

/business_registry/registration_code:
get:
summary: Get registration code for reserved domain
description: |
Returns the registration code (password) for a reserved domain.
This code is crucial for the domain registration process with registrars.
The registrar will require this code to verify and complete the registration of the reserved domain.
Note: Keep this code confidential and provide it only to your chosen registrar when initiating the domain registration process.
security:
- CustomTokenAuth: []
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the reserved domain
example: "example-company.ee"
registration_code:
type: string
description: The registration code (password) to be used when registering the domain with a registrar
example: "secure_registration_code_123xyz"
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Reserved domain not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/business_registry/registration_code:
get:
summary: Get registration code for reserved domain
description: |
Returns the registration code (password) for a reserved domain.
This code is crucial for the domain registration process with registrars.
The registrar will require this code to verify and complete the registration of the reserved domain.
Note: Keep this code confidential and provide it only to your chosen registrar when initiating the domain registration process.
security:
- CustomTokenAuth: []
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the reserved domain
example: "example-company.ee"
registration_code:
type: string
description: The registration code (password) to be used when registering the domain with a registrar
example: "secure_registration_code_123xyz"
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Reserved domain not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'

/business_registry/release:
delete:
Expand Down

0 comments on commit cbfd4e3

Please sign in to comment.