Skip to content

Commit

Permalink
Version 2024-release-11 OpenApi kuvausten alustavat muutokset
Browse files Browse the repository at this point in the history
  • Loading branch information
@maxmakisalo
maxmakisalo committed Sep 11, 2024
1 parent 4d50fe9 commit 6e0e9ca
Show file tree
Hide file tree
Showing 4 changed files with 586 additions and 196 deletions.
143 changes: 99 additions & 44 deletions OpenApi/Kaavoitus/Avoin/ryhti-plan-public-validate-api.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.1",
"info": {
"title": "Ryhti API",
"description": "<h2>Ryhti - kaavasuunnitelmien julkinen validointirajapinta</h2>\n\nJulkinen rajapinta kaavasuunnitelmien validointiin.\n\nLisää tietoa rakennetun ympäristön tietojärjestelmästä: <a href=\"https://ryhti.syke.fi/\">https://ryhti.syke.fi/</a>\n<br/>",
"description": "<h2>Ryhti - kaavasuunnitelmien julkinen validointirajapinta</h2>\r\n\r\nJulkinen rajapinta kaavasuunnitelmien validointiin.\r\n\r\nLisää tietoa rakennetun ympäristön tietojärjestelmästä: <a href=\"https://ryhti.syke.fi/\">https://ryhti.syke.fi/</a>\r\n<br/>",
"contact": {
"name": "Feedback",
"url": "https://www.syke.fi/en-US/SYKE_Info/Contact_information/Feedback_form(10043)?r=38611"
Expand Down Expand Up @@ -271,22 +271,20 @@
},
"CancelledGroupRelations": {
"required": [
"planObjectKey",
"planRegulationGroupKey"
"planObjectUri",
"planRegulationGroupUri"
],
"type": "object",
"properties": {
"planRegulationGroupKey": {
"planRegulationGroupUri": {
"minLength": 1,
"type": "string",
"description": "Kaavamääräysryhmän kohdistamiseen käytettävä tunnus.",
"format": "uuid"
"description": "Kaavamääräysryhmän kohdistamiseen käytettävä tunnus URI-muodossa (https://uri.rakennetunymparistontietojarjestelma.fi/planregulationgroup/{planRegulationGroupKey})"
},
"planObjectKey": {
"planObjectUri": {
"minLength": 1,
"type": "string",
"description": "Kaavakohteen kohdistamiseen käytettävä tunnus.",
"format": "uuid"
"description": "Kaavakohteen kohdistamiseen käytettävä tunnus URI-muodossa (https://uri.rakennetunymparistontietojarjestelma.fi/planobject/{planObjectKey})"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -463,6 +461,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"generalRegulationGroupUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/generalregulationgroup/{guid})",
"readOnly": true
},
"titleOfPlanRegulation": {
"allOf": [
{
Expand Down Expand Up @@ -1003,6 +1006,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"otherPlanMaterialUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/otherplanmaterial/{guid})",
"readOnly": true
},
"name": {
"allOf": [
{
Expand Down Expand Up @@ -1036,17 +1044,23 @@
"additionalProperties": false,
"description": "MuuKaavaAineisto"
},
"PartiallyCancellationPlanObjectInfo": {
"PartiallyCancelledPlanObjectInfo": {
"required": [
"partiallyCancelledPlanObjectId",
"cancelledPlanUri",
"partiallyCancelledPlanObjectUri",
"validityGeometry"
],
"type": "object",
"properties": {
"partiallyCancelledPlanObjectId": {
"cancelledPlanUri": {
"minLength": 1,
"type": "string",
"description": "Kumottavan hyväkstytyn kaavan tunnus URI-muodossa (https://uri.rakennetunymparistontietojarjestelma.fi/plan/{planKey})"
},
"partiallyCancelledPlanObjectUri": {
"minLength": 1,
"type": "string",
"description": "Kaavakohteen yksilöivätunnus, jota osittainen kumoutuminen koskee."
"description": "Kumottavan kaavakohteen tunnus uri-muodossa (https://uri.rakennetunymparistontietojarjestelma.fi/planobject/{planObjectKey})"
},
"validityGeometry": {
"allOf": [
Expand Down Expand Up @@ -1075,6 +1089,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"planUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/plan/{guid})",
"readOnly": true
},
"lifeCycleStatus": {
"enum": [
"http://uri.suomi.fi/codelist/rytj/kaavaelinkaari/code/01",
Expand Down Expand Up @@ -1204,10 +1223,10 @@
"description": "Laatija",
"nullable": true
},
"partiallyCancellationPlanObjects": {
"partiallyCancelledPlanObjects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartiallyCancellationPlanObjectInfo"
"$ref": "#/components/schemas/PartiallyCancelledPlanObjectInfo"
},
"description": "// Osittain kumottavat kaavakohteet",
"nullable": true
Expand Down Expand Up @@ -1328,6 +1347,11 @@
"format": "date",
"nullable": true
},
"planAttachmentDocumentUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/planattachmentdocument/{guid})",
"readOnly": true
},
"typeOfAttachment": {
"minLength": 1,
"type": "string",
Expand Down Expand Up @@ -1363,10 +1387,7 @@
},
"PlanCancellationInfo": {
"required": [
"cancelledGuidanceId",
"cancelledPlanId",
"cancelledPlanObjectId",
"cancelledRegulationId",
"cancelledPlanUri",
"cancelsEntirePlan",
"planCancellationInfoKey"
],
Expand All @@ -1377,49 +1398,47 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"cancelledPlanId": {
"planCancellationInfoUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/plancancellationinfo/{guid})",
"readOnly": true
},
"cancelledPlanUri": {
"minLength": 1,
"type": "string",
"description": "Kumottavan kaavan tunnus"
"description": "Kumottavan hyväkstytyn kaavan tunnus URI-muodossa (https://uri.rakennetunymparistontietojarjestelma.fi/plan/{planKey})"
},
"cancelsEntirePlan": {
"type": "boolean",
"description": "Kumoaa kaavan kokonaan"
},
"cancelledPlanObjectId": {
"cancelledPlanObjectUris": {
"type": "array",
"items": {
"minLength": 1,
"type": "string"
},
"description": "Kumottavan kaavakohteen tunnukset",
"nullable": true
"description": "Kumottavan kaavakohteen tunnukset URI-muodossa (https://uri.rakennetunymparistontietojarjestelma.fi/planobject/{planObjectKey})"
},
"cancelledRegulationId": {
"cancelledRegulationUris": {
"type": "array",
"items": {
"minLength": 1,
"type": "string"
},
"description": "Kumottavan määräyksen tunnukset",
"nullable": true
"description": "Kumottavan määräyksen tunnukset URI-muodossa (https://uri.rakennetunymparistontietojarjestelma.fi/planregulation/{planRegulationKey})"
},
"cancelledGuidanceId": {
"cancelledRecommendationUris": {
"type": "array",
"items": {
"minLength": 1,
"type": "string"
},
"description": "Kumottavan suosituksen tunnukset",
"nullable": true
"description": "Kumottavan suosituksen tunnukset URI-muodossa (https://uri.rakennetunymparistontietojarjestelma.fi/planrecommendation/{planRecommendationKey})"
},
"cancelledGroupRelations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CancelledGroupRelations"
},
"description": "Kumottavan ryhmän kohdistus. Kuvaa kaavakohteesta kumoutuvat kaavamääräysryhmät.",
"nullable": true
"description": "Kumottavan ryhmän kohdistus. Kuvaa kaavakohteesta kumoutuvat kaavamääräysryhmät."
}
},
"additionalProperties": false,
Expand All @@ -1439,6 +1458,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"planMapUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/planmap/{guid})",
"readOnly": true
},
"name": {
"allOf": [
{
Expand Down Expand Up @@ -1474,6 +1498,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"planObjectUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/planobject/{guid})",
"readOnly": true
},
"lifeCycleStatus": {
"enum": [
"http://uri.suomi.fi/codelist/rytj/kaavaelinkaari/code/01",
Expand Down Expand Up @@ -1543,7 +1572,15 @@
"type": "string",
"format": "uuid"
},
"description": "Viittaus (GUID) kaavan mukana toimitettavaan lähtötietoaineistoon sisältyvään tietokohteeseen, joka liittyy​ kaavakohteeseen. Esim. Pohjavesialue.",
"description": "Viittaus (GUID) kaavan mukana toimitettavaan lähtötietoaineistoon sisältyvään tietokohteeseen, joka liittyy kaavakohteeseen. Esim. Pohjavesialue.\r\nPäivitysvaiheessa tämän listan kuuluu olla tyhjä.",
"nullable": true
},
"relatedPlanSourceDataUris": {
"type": "array",
"items": {
"type": "string"
},
"description": "Viittaus (URI) kaava-asian mukana toimitettavaan, aiemmin tallennettuun, lähtötietoaineistoon sisältyvään tietokohteeseen, joka liittyy tallennettuun kaavakohteeseen. Esim. Pohjavesialue.",
"nullable": true
},
"periodOfValidity": {
Expand Down Expand Up @@ -1585,6 +1622,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"planOperatorUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/planoperator/{guid})",
"readOnly": true
},
"firstName": {
"type": "string",
"description": "Etunimi",
Expand Down Expand Up @@ -1627,6 +1669,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"planRecommendationUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/planrecommendation/{guid})",
"readOnly": true
},
"value": {
"allOf": [
{
Expand Down Expand Up @@ -1706,6 +1753,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"planRegulationUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/planregulation/{guid})",
"readOnly": true
},
"value": {
"oneOf": [
{
Expand Down Expand Up @@ -2149,6 +2201,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"planRegulationGroupUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/planregulationgroup/{guid})",
"readOnly": true
},
"titleOfPlanRegulation": {
"allOf": [
{
Expand Down Expand Up @@ -2218,6 +2275,11 @@
"description": "Tiedon tuottajatahon tietojärjestelmän generoima kohteen versioriippumaton tunnus",
"format": "uuid"
},
"planReportUri": {
"type": "string",
"description": "Luokan pysyvä URI -muotoinen viittaustunniste (https://uri.rakennetunymparistontietojarjestelma.fi/planreport/{guid})",
"readOnly": true
},
"attachmentDocuments": {
"minItems": 1,
"type": "array",
Expand Down Expand Up @@ -2641,14 +2703,7 @@
"flows": {
"clientCredentials": {
"tokenUrl": "https://identitytest.ymparisto.fi/connect/token",
"scopes": {
"ryhti.plan.write": "Kaavatietojen kirjoitusoikeus",
"ryhti.building.write": "Rakennustietojen kirjoitusoikeus",
"ryhti.planui.write": "Käyttöliittymä apin käyttöoikeus",
"ryhti.changeinformation.read": "Muutostietojen lukuoikeus",
"ryhti.changeinformation.building.all": "Kaikkien muutostietojen lukuoikeus",
"ryhti.changeinformation.building.generalized": "Karkeutettujen muutostietojen lukuoikeus"
}
"scopes": {}
}
}
}
Expand Down
Loading

0 comments on commit 6e0e9ca

Please sign in to comment.