My API documentation contains a few GET and POST requests that I have saved example responses for that the user can view. I have noticed that if a response exceeds a certain length, the normal JSON text colors no longer apply and it turns into all white colored text (dark theme). I have ensured that:
- The JSON is valid (using JSONLint)
- The Content-Type header in the response is set to “application/json”
The only way this error occurs is when the response is longer than whatever limit Postman must be enforcing somewhere. Has anybody else experienced this behavior?
Here is a response where the API documentation will publish it without text coloration:
{
"success": true,
"message": "",
"result": [
{
"layer_id": 1,
"layer_name": "Non-powered Dams",
"geoserver_name": "npd",
"table_name": "npd",
"description": "Non-powered dams in the USA"
},
{
"layer_id": 2,
"layer_name": "Wild and Scenic Rivers",
"geoserver_name": "wild_scenic_rivers",
"table_name": "wild_scenic_rivers",
"description": "Rivers in the National Wild and Scenic Rivers System"
},
{
"layer_id": 3,
"layer_name": "County-based Hydropower Potential from Conduits",
"geoserver_name": "conduit_counties",
"table_name": "conduit_counties_view",
"description": "Hydropower generation potential at the county scale"
},
{
"layer_id": 4,
"layer_name": "State-based Hydropower Potential from Conduits",
"geoserver_name": "conduit_states",
"table_name": "conduit_states_view",
"description": "Hydropower generation potential at the state scale"
},
{
"layer_id": 5,
"layer_name": "County Boundaries",
"geoserver_name": "county_boundaries",
"table_name": "county_boundaries_view",
"description": "County boundaries in the USA"
},
{
"layer_id": 6,
"layer_name": "Operational Plants",
"geoserver_name": "eha_operational",
"table_name": "eha_operational_view",
"description": "Operational hydropower plants in the USA"
},
{
"layer_id": 7,
"layer_name": "Plants Undergoing Relicensing",
"geoserver_name": "eha_relicense",
"table_name": "eha_relicense_view",
"description": "Hydropower plants currently undergoing relicensing in the USA"
},
{
"layer_id": 8,
"layer_name": "Retired Plants",
"geoserver_name": "eha_retired",
"table_name": "eha_retired_view",
"description": "Retired hydropower plants in the USA"
},
{
"layer_id": 9,
"layer_name": "Plants Surrendering License",
"geoserver_name": "eha_surrender",
"table_name": "eha_surrender_view",
"description": "Hydropower plants currently in the process of surrendering their license in the USA"
},
{
"layer_id": 10,
"layer_name": "Operational Units",
"geoserver_name": "eha_units",
"table_name": "eha_units_view",
"description": "Operational hydropower plant turbine units in the USA"
},
{
"layer_id": 11,
"layer_name": "Environmental Mitigation",
"geoserver_name": "env_mitigation",
"table_name": "env_mitigation_view",
"description": "Environmental mitigation requirements by hydropower plant"
},
{
"layer_id": 12,
"layer_name": "Fish Traits",
"geoserver_name": "fish_traits",
"table_name": "fish_traits_view",
"description": "Fish traits by HUC 8 watershed boundary"
},
{
"layer_id": 13,
"layer_name": "HILARRI",
"geoserver_name": "hilarri",
"table_name": "hilarri_view",
"description": "The Hydropower Infrastructure - Lakes, Reservoirs, and Rivers dataset links together major datasets of operational hydropower dams, powerplants, and inland water bodies"
},
{
"layer_id": 14,
"layer_name": "Hydropower Energy Storage Capacity",
"geoserver_name": "hydro_energy_storage_v2",
"table_name": "hydro_energy_storage_v2_view",
"description": "The Hydropower Energy Storage Capacity (HESC) dataset catalogs characteristics that are relevant to evaluating reservoir storage and estimates of energy storage capacity based on varying levels of detail"
},
{
"layer_id": 15,
"layer_name": "Hydrologic Class",
"geoserver_name": "hydrologic_class",
"table_name": "hydrologic_class_view",
"description": "HUC 2, 4, 6, and 8 watershed boundary information"
},
{
"layer_id": 16,
"layer_name": "Listed Fish Species",
"geoserver_name": "listed_fish",
"table_name": "listed_fish_view",
"description": "Fish species listed under the Endagered Species Act or by the International Union for the Conservation of Nature per HUC 8 watershed"
},
{
"layer_id": 18,
"layer_name": "Environmental Attributes",
"geoserver_name": "nsd_env_attrb",
"table_name": "nsd_env_attrb_view",
"description": "The Environmental Attribution within the DOE/ORNL NSD Resource Assessment is a geospatial framework with the objective of determining potential environmental concerns related to new hydropower development"
},
{
"layer_id": 22,
"layer_name": "Water Use",
"geoserver_name": "water_use",
"table_name": "water_use_view",
"description": "Estimated water use (2005), population density, housing density, precipitation, and potential evapotranspiration per HUC 8 watershed"
},
{
"layer_id": 24,
"layer_name": "Hydro Fish",
"geoserver_name": "hydro_fish",
"table_name": "hydro_fish",
"description": "A list of all freshwater fish species in a huc_8."
}
]
}
Here is a response that will be colored correctly in the published API documentation. Notice that all I did was remove the last object from the result array to make the response shorter:
{
"success": true,
"message": "",
"result": [
{
"layer_id": 1,
"layer_name": "Non-powered Dams",
"geoserver_name": "npd",
"table_name": "npd",
"description": "Non-powered dams in the USA"
},
{
"layer_id": 2,
"layer_name": "Wild and Scenic Rivers",
"geoserver_name": "wild_scenic_rivers",
"table_name": "wild_scenic_rivers",
"description": "Rivers in the National Wild and Scenic Rivers System"
},
{
"layer_id": 3,
"layer_name": "County-based Hydropower Potential from Conduits",
"geoserver_name": "conduit_counties",
"table_name": "conduit_counties_view",
"description": "Hydropower generation potential at the county scale"
},
{
"layer_id": 4,
"layer_name": "State-based Hydropower Potential from Conduits",
"geoserver_name": "conduit_states",
"table_name": "conduit_states_view",
"description": "Hydropower generation potential at the state scale"
},
{
"layer_id": 5,
"layer_name": "County Boundaries",
"geoserver_name": "county_boundaries",
"table_name": "county_boundaries_view",
"description": "County boundaries in the USA"
},
{
"layer_id": 6,
"layer_name": "Operational Plants",
"geoserver_name": "eha_operational",
"table_name": "eha_operational_view",
"description": "Operational hydropower plants in the USA"
},
{
"layer_id": 7,
"layer_name": "Plants Undergoing Relicensing",
"geoserver_name": "eha_relicense",
"table_name": "eha_relicense_view",
"description": "Hydropower plants currently undergoing relicensing in the USA"
},
{
"layer_id": 8,
"layer_name": "Retired Plants",
"geoserver_name": "eha_retired",
"table_name": "eha_retired_view",
"description": "Retired hydropower plants in the USA"
},
{
"layer_id": 9,
"layer_name": "Plants Surrendering License",
"geoserver_name": "eha_surrender",
"table_name": "eha_surrender_view",
"description": "Hydropower plants currently in the process of surrendering their license in the USA"
},
{
"layer_id": 10,
"layer_name": "Operational Units",
"geoserver_name": "eha_units",
"table_name": "eha_units_view",
"description": "Operational hydropower plant turbine units in the USA"
},
{
"layer_id": 11,
"layer_name": "Environmental Mitigation",
"geoserver_name": "env_mitigation",
"table_name": "env_mitigation_view",
"description": "Environmental mitigation requirements by hydropower plant"
},
{
"layer_id": 12,
"layer_name": "Fish Traits",
"geoserver_name": "fish_traits",
"table_name": "fish_traits_view",
"description": "Fish traits by HUC 8 watershed boundary"
},
{
"layer_id": 13,
"layer_name": "HILARRI",
"geoserver_name": "hilarri",
"table_name": "hilarri_view",
"description": "The Hydropower Infrastructure - Lakes, Reservoirs, and Rivers dataset links together major datasets of operational hydropower dams, powerplants, and inland water bodies"
},
{
"layer_id": 14,
"layer_name": "Hydropower Energy Storage Capacity",
"geoserver_name": "hydro_energy_storage_v2",
"table_name": "hydro_energy_storage_v2_view",
"description": "The Hydropower Energy Storage Capacity (HESC) dataset catalogs characteristics that are relevant to evaluating reservoir storage and estimates of energy storage capacity based on varying levels of detail"
},
{
"layer_id": 15,
"layer_name": "Hydrologic Class",
"geoserver_name": "hydrologic_class",
"table_name": "hydrologic_class_view",
"description": "HUC 2, 4, 6, and 8 watershed boundary information"
},
{
"layer_id": 16,
"layer_name": "Listed Fish Species",
"geoserver_name": "listed_fish",
"table_name": "listed_fish_view",
"description": "Fish species listed under the Endagered Species Act"
},
{
"layer_id": 18,
"layer_name": "Environmental Attributes",
"geoserver_name": "nsd_env_attrb",
"table_name": "nsd_env_attrb_view",
"description": "The Environmental Attribution within the DOE/ORNL NSD Resource Assessment is a geospatial framework with the objective of determining potential environmental concerns related to new hydropower development"
},
{
"layer_id": 22,
"layer_name": "Water Use",
"geoserver_name": "water_use",
"table_name": "water_use_view",
"description": "Estimated water use (2005), population density, housing density, precipitation, and potential evapotranspiration per HUC 8 watershed"
}
]
}
Bad coloration in published docs:
Correct coloration:
