mirror of
https://gitlab.com/PronounsPage/PronounsPage.git
synced 2025-09-22 12:03:25 -04:00
Update potential documentations
This commit is contained in:
parent
3f55ff1c26
commit
4419193ec9
@ -4,10 +4,10 @@ info:
|
||||
title: Pronouns.Page API
|
||||
description: |-
|
||||
The Pronouns.Page API allows you to retrieve and manage pronoun data for users.
|
||||
termsOfService: http://en.pronouns.page/terms/
|
||||
termsOfService: https://en.pronouns.page/terms/
|
||||
contact:
|
||||
name: Support
|
||||
url: http://en.pronouns.page/contact/
|
||||
url: https://en.pronouns.page/contact/
|
||||
email: contact@pronouns.page
|
||||
license:
|
||||
name: Opinionated Queer License (OQL) v1.1
|
||||
@ -31,7 +31,7 @@ servers:
|
||||
paths:
|
||||
/pronouns:
|
||||
get:
|
||||
x-state: In Development
|
||||
x-beta: true
|
||||
summary: Retrieve a list of pronouns
|
||||
description: Get a list of all available pronouns.
|
||||
responses:
|
||||
@ -98,7 +98,7 @@ paths:
|
||||
example: Internal server error
|
||||
/pronouns/{pronoun}:
|
||||
get:
|
||||
x-state: In Development
|
||||
x-beta: true
|
||||
summary: Retrieve a specific pronoun set
|
||||
description: Get details of a specific pronoun set by its canonical name.
|
||||
parameters:
|
||||
@ -121,7 +121,7 @@ paths:
|
||||
normative: true
|
||||
morphemes:
|
||||
pronoun_subject: they
|
||||
pronoun_object: them
|
||||
pronoun_object: them
|
||||
possessive_determiner: their
|
||||
possessive_pronoun: theirs
|
||||
reflexive: themself
|
||||
@ -178,6 +178,46 @@ paths:
|
||||
error:
|
||||
type: string
|
||||
example: Internal server error
|
||||
/banner/{pronoun}.png:
|
||||
get:
|
||||
x-beta: true
|
||||
summary: Retrieve a pronoun badge image
|
||||
description: Get a PNG image badge for a specific pronoun set by its canonical name.
|
||||
parameters:
|
||||
- name: pronoun
|
||||
in: path
|
||||
required: true
|
||||
description: The canonical name of the pronoun set (e.g., "they/them").
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: A PNG image badge representing the pronoun set
|
||||
content:
|
||||
image/png:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
'404':
|
||||
description: Pronoun set not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
type: string
|
||||
example: Pronoun set not found
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
type: string
|
||||
example: Internal server error
|
||||
components:
|
||||
securitySchemes:
|
||||
APIKeyHeader:
|
BIN
docs/docs.plist
Normal file
BIN
docs/docs.plist
Normal file
Binary file not shown.
1
docs/en.yaml
Normal file
1
docs/en.yaml
Normal file
@ -0,0 +1 @@
|
||||
openapi: 3.1.1
|
Loading…
x
Reference in New Issue
Block a user