Skip to content
Snippets Groups Projects
Commit e27bce43 authored by David Schwarzmann's avatar David Schwarzmann
Browse files

Remove old specs and models

parent c3e1ef70
No related branches found
No related tags found
1 merge request!43Introduce docusaurus
{
"type": "object",
"title": "Application Metadata without ID",
"description": "Metadaten eines Antrags noch ohne ID, zum Anlegen eines neuen Antrags. Nach dem Zuweisen der `application-id` wird das Modell [Application Metadata](metadata.json) verwendet.",
"x-examples": {
"example-1": {
"additionalReferenceInfo": {
"subject": "Anmeldung eines Gewerbes in Musterstadt",
"caseId": "DF/8923"
},
"contentStructure": {
"data": {
"schema": {
"mimeType": "application/json",
"schemaSource": "none"
}
},
"docs": [
{
"docId": "1",
"purpose": "form",
"size": 13046,
"mimeType": "application/pdf",
"filename": "test.pdf",
"description": "Das Antragsformular",
"lang": {
"lang": "de",
"region": "DE"
},
"hash": {
"algorithm": "SHA-256",
"digest": "bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9"
}
}
]
},
"publicServiceType": {
"name": "Gewerbeanmeldung",
"description": "Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.",
"leikaId": "99050012104000",
"otherIdentifiers": [
{
"id": "8664844",
"schemeID": "service.niedersachsen.de",
"schemeName": "Serviceportal Niedersachsen"
},
{
"id": "354824",
"schemeID": "buerger.thueringen.de",
"schemeName": "Zuständigkeitsfinder Thüringen"
}
]
}
}
},
"properties": {
"publicServiceType": {
"$ref": "./public-service-type.json"
},
"contentStructure": {
"type": "object",
"additionalProperties": false,
"required": [
"docs"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"schema": {
"$ref": "./schema.json"
}
},
"required": [
"schema"
]
},
"docs": {
"type": "array",
"items": {
"$ref": "./document.json"
}
}
}
},
"additionalReferenceInfo": {
"type": "object",
"additionalProperties": false,
"properties": {
"subject": {
"type": "string"
},
"caseId": {
"type": "string"
},
"applicationDate": {
"type": "string",
"format": "date",
"description": "Antragsdatum"
}
}
}
},
"required": [
"contentStructure"
]
}
\ No newline at end of file
{
"title": "Application Metadata",
"allOf": [
{
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"pattern": "^[-_.A-Za-z0-9]+$",
"description": "ID des Antrags"
}
},
"required": [
"applicationId"
]
},
{
"$ref": "./metadata-no-id.json"
}
],
"description": "Metadaten zu einem Antrag.",
"x-examples": {
"example-1": {
"additionalReferenceInfo": {
"subject": "Anmeldung eines Gewerbes in Musterstadt",
"caseId": "DF/8923"
},
"contentStructure": {
"data": {
"schema": {
"mimeType": "application/json",
"schemaSource": "none"
}
},
"docs": [
{
"docId": "1",
"purpose": "form",
"size": 13046,
"mimeType": "application/pdf",
"filename": "test.pdf",
"description": "Das Antragsformular",
"lang": {
"lang": "de",
"region": "DE"
},
"hash": {
"algorithm": "SHA-256",
"digest": "bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9"
}
}
]
},
"publicServiceType": {
"name": "Gewerbeanmeldung",
"description": "Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.",
"leikaId": "99050012104000",
"otherIdentifiers": [
{
"id": "8664844",
"schemeID": "service.niedersachsen.de",
"schemeName": "Serviceportal Niedersachsen"
},
{
"id": "354824",
"schemeID": "buerger.thueringen.de",
"schemeName": "Zuständigkeitsfinder Thüringen"
}
]
},
"applicationId": "ce75a6b8-d72f-4b94-b09e-af6be35bc2ae"
}
}
}
\ No newline at end of file
{
"type": "object",
"title": "Application Schema",
"description": "Strukturinformationen zu übertragbaren oder übertragenen Daten.",
"additionalProperties": false,
"x-examples": {
"example-1": {
"mimeType": "application/json",
"schemaSource": "none",
"schemaId": "JSON-DOC"
},
"example-2": {
"mimeType": "application/xml",
"schemaSource": "none",
"schemaId": "XML-DOC"
},
"example-3": {
"mimeType": "application/xml",
"schemaSource": "fim",
"schemaId": "S99000001V1.0"
},
"example-4": {
"mimeType": "application/json",
"schemaSource": "fitconnect",
"schemaId": "applicant-person"
},
"example-5": {
"mimeType": "application/json",
"schemaSource": "fitconnect",
"schemaId": "payment-info"
}
},
"properties": {
"schemaId": {
"type": "string",
"description": "ID des Schemas, abhängig von der ausgewählten Quelle."
},
"schemaSource": {
"type": "string",
"enum": [
"fim",
"none"
],
"description": "Quelle, von der das Schema bezogen werden kann."
},
"mimeType": {
"type": "string",
"enum": [
"application/json",
"application/xml"
],
"description": "Gibt das zulässige Format (JSON oder XML) der Fachdaten an."
}
},
"required": [
"schemaSource",
"mimeType",
"schemaId"
]
}
\ No newline at end of file
{
"title": "JSON Web Encryption (JWE)",
"type": "object",
"description": "JSON Web Encryption - JSON Serialization - RFC 7516",
"properties": {
"protected": {
"$ref": "./base64url.json"
},
"unprotected": {
"type": "object",
"properties": {
"alg": {
"type": "string",
"description": "Algorithm",
"enum": [
"RSA-OAEP-256"
]
},
"enc": {
"type": "string",
"description": "Encryption Algorithm",
"enum": [
"A256GCM"
]
},
"zip": {
"type": "string",
"description": "Compression Algorithm",
"enum": [
"DEF"
]
},
"kid": {
"description": "Key ID"
}
}
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"header": {
"$ref": "#/properties/unprotected"
},
"encrypted_key": {
"$ref": "./base64url.json"
}
}
}
},
"encrypted_key": {
"type": "object"
},
"iv": {
"$ref": "./base64url.json"
},
"aad": {
"$ref": "./base64url.json"
},
"ciphertext": {
"$ref": "./base64url.json"
},
"tag": {
"$ref": "./base64url.json"
}
},
"required": [
"protected",
"recipients",
"ciphertext"
]
}
\ No newline at end of file
{
"title": "JSON Web Key (JWK)",
"type": "object",
"description": "JSON Web Key - RFC 7517",
"properties": {
"kty": {
"type": "string",
"description": "Key Type",
"enum": [
"RSA"
]
},
"key_ops": {
"type": "array",
"enum": [
"verify",
"wrapKey"
],
"description": "Key Operations",
"items": {
"type": "string"
}
},
"alg": {
"type": "string",
"description": "Algorithm",
"enum": [
"PS512",
]
},
"kid": {
"description": "Key ID",
"type": "string"
},
"x5c": {
"description": "X.509 Certificate Chain",
"type": "array",
"items": {
"$ref": "./base64.json"
}
},
"x5t": {
"$ref": "./base64url.json"
}
},
"required": [
"kty",
"kid",
"key_ops",
"alg",
"x5c",
"x5t"
]
}
\ No newline at end of file
{
"type": "object",
"title": "Destination without ID",
"description": "Daten eines technischen Übergabepunkts (Ziel der Übertragung - z.B. ein Fachverfahren) noch ohne ID, zum Anlegen eines neuen Übergabepunkts. Nach dem Zuweisen der `destination-id` wird das Modell [Destination](destination.json) verwendet.",
"x-examples": {
"example-1": {
"publicOrganization": {
"organizationName": "Gewerbeamt Musterstadt",
"address": {
"type": "national",
"street": "Kurzer Weg",
"houseNumber": "7",
"postalCode": "12345",
"city": "Ankh-Morpork"
},
"contact": {
"telephones": [
{
"number": "+49 89 32168-0",
"mobile": false,
"description": "work"
}
],
"email": "behoerde@example.com"
}
},
"technicalContact": [
{
"formOfAddress": "Herr",
"doctoralDegrees": "Dr.",
"firstName": "Kunibert",
"lastName": "Vonundzu",
"contact": {
"telephones": [
{
"number": "+49 89 32168-42",
"mobile": false,
"description": "work"
},
{
"number": "+49 123 456789",
"mobile": true,
"description": "work"
}
],
"email": "kunibert.vonundzu@example.com"
}
}
],
"schemas": [
{
"mimeType": "application/json",
"schemaSource": "none"
}
],
"callback": {
"callbackURI": "http://127.0.0.1:4010/voluptas"
},
"publicKeys": {
"keys": [
{
"kty": "RSA",
"alg": "PS512",
"key_ops": ["wrapKey"],
"kid": "d4d3bd67-420f-4b39-85d9-92dd800c57b5",
"x5t": "……(Fingerprint)……",
"x5c": [
"……(base64 encoded root cert)……",
"……(base64 encoded intermediate cert)……",
"……(base64 encoded cert)……"
]
},
{
"kty": "RSA",
"key_ops": ["verify"],
"alg": "PS512",
"kid": "……(Key ID)……",
"x5t": "……(Fingerprint)……",
"x5c": [
"……(base64 encoded root cert)……",
"……(base64 encoded intermediate cert)……",
"……(base64 encoded cert)……"
]
}
]
}
}
},
"properties": {
"publicOrganization": {
"type": "object",
"properties": {
"organizationName": {
"type": "string"
},
"address": {
"description": "Adresse als Alternative (Choice) von nationaler und internationaler Adresse.",
"oneOf": [
{
"$ref": "./common/address-national.json"
},
{
"$ref": "./common/address-postbox.json"
},
{
"$ref": "./common/address-international.json"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"national": "./common/address-national.json",
"international": "./common/address-international.json",
"postbox": "./common/address-postbox.json"
}
}
},
"identifiers": {
"type": "array",
"description": "Externe Identifikatoren der Person",
"items": {
"$ref": "./common/identifier.json"
}
},
"contact": {
"description": "Kontaktmöglichkeiten der Behörde",
"type": "object",
"properties": {
"telephones": {
"type": "array",
"description": "Liste der Telefonnummern, außer Fax",
"items": {
"$ref": "./common/phone.json"
}
},
"email": {
"type": "string",
"format": "email",
"description": "E-Mail-Adresse"
},
"www": {
"type": "string",
"format": "uri",
"description": "Webadresse"
},
"telefax": {
"$ref": "./common/phone.json#/properties/number"
}
}
}
}
},
"technicalContact": {
"type": "array",
"description": "Technischer Ansprechpartner",
"items": {
"$ref": "./common/individual.json"
}
},
"schemas": {
"type": "array",
"description": "Zulässige Schemas, die zu diesem Ziel übertragen werden können. Sofern leer dürfen Anträge (Application) keinen Datensatz (ApplicationData) enthalten.",
"items": {
"$ref": "./application/schema.json"
}
},
"callback": {
"type": "object",
"description": "Callback zur Benachrichtigung bei neuen Anträgen",
"properties": {
"callbackURI": {
"type": "string",
"description": "URL auf die der Callback als POST durchgeführt wird",
"format": "uri"
}
},
"required": [
"callbackURI"
]
},
"publicKey": {
"$ref": "./common/jwk.json"
}
}
}
\ No newline at end of file
{
"title": "Destination",
"allOf": [
{
"type": "object",
"properties": {
"destinationId": {
"description": "Vom Zustelldienst für dieses Ziel vergebene ID. Wird beim Anlegen eines neuen Ziels leer gelassen.",
"pattern": "^[-_.A-Za-z0-9]+$",
"type": "string"
}
},
"required": [
"destinationId"
]
},
{
"$ref": "./destination-no-id.json"
}
],
"description": "Beschreibung eines technischen Übergabepunkts",
"x-examples": {
"example-1": {
"publicOrganization": {
"organizationName": "Gewerbeamt Musterstadt",
"address": {
"type": "national",
"street": "Kurzer Weg",
"houseNumber": "7",
"postalCode": "12345",
"city": "Ankh-Morpork"
},
"contact": {
"telephones": [
{
"number": "+49 89 32168-0",
"mobile": false,
"description": "work"
}
],
"email": "behoerde@example.com"
}
},
"technicalContact": [
{
"formOfAddress": "Herr",
"doctoralDegrees": "Dr.",
"firstName": "Kunibert",
"lastName": "Vonundzu",
"contact": {
"telephones": [
{
"number": "+49 89 32168-42",
"mobile": false,
"description": "work"
},
{
"number": "+49 123 456789",
"mobile": true,
"description": "work"
}
],
"email": "kunibert.vonundzu@example.com"
}
}
],
"schemas": [
{
"mimeType": "application/json",
"schemaSource": "none"
}
],
"callback": {
"callbackURI": "http://127.0.0.1:4010/voluptas"
},
"publicKeys": {
"keys": [
{
"kty": "RSA",
"key_ops": ["wrapKey"],
"alg": "PS512",
"kid": "……(Key ID)……",
"x5t": "……(Fingerprint)……",
"x5c": [
"……(base64 encoded root cert)……",
"……(base64 encoded intermediate cert)……",
"……(base64 encoded cert)……"
]
},
{
"kty": "RSA",
"key_ops": ["verify"],
"alg": "PS512",
"kid": "……(Key ID)……",
"x5t": "……(Fingerprint)……",
"x5c": [
"……(base64 encoded root cert)……",
"……(base64 encoded intermediate cert)……",
"……(base64 encoded cert)……"
]
}
]
},
"destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047"
}
}
}
\ No newline at end of file
This diff is collapsed.
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment