Files
go-nkode/docs/swagger.yaml
2024-11-26 11:32:20 -06:00

71 lines
1.6 KiB
YAML

basePath: /
definitions:
core.CreateNewCustomerResp:
properties:
customer_id:
type: string
type: object
core.NKodePolicy:
properties:
distinct_attributes:
type: integer
distinct_sets:
type: integer
expiration:
description: seconds, -1 no expiration
type: integer
lock_out:
type: integer
max_nkode_len:
type: integer
min_nkode_len:
type: integer
type: object
core.NewCustomerPost:
properties:
nkode_policy:
$ref: '#/definitions/core.NKodePolicy'
type: object
host: localhost:8080
info:
contact:
email: support@nkode.example.com
name: API Support
url: http://nkode.example.com/support
description: This is the NKode API server.
license:
name: MIT
url: https://opensource.org/licenses/MIT
termsOfService: http://nkode.example.com/terms/
title: NKode API
version: "1.0"
paths:
/create-new-customer:
post:
consumes:
- application/json
description: Creates a new customer based on the provided policy information.
parameters:
- description: Customer creation data
in: body
name: NewCustomerPost
required: true
schema:
$ref: '#/definitions/core.NewCustomerPost'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/core.CreateNewCustomerResp'
summary: Create a new customer
tags:
- customers
securityDefinitions:
ApiKeyAuth:
in: header
name: Authorization
type: apiKey
swagger: "2.0"